ShareWare OnLine 2

home *** CD-ROM | disk | FTP | other *** search

/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / bbsdoors / cbox23.zip / CHATBOX.DOC < prev next >

Wrap

Text File | 1993-05-04 | 68KB | 1,501 lines

------------------------------------------------------------------ | | | | | | | ChatBox Version 2.3 | | | | Split-Screen Sysop Chat - Caller Page Utility | | | | For | | | | PCBoard Versions 14.5, 14.5a & 15.0 | | | | Including | | | | PCBoard /M Multi-port | | | | | | Horizontal or Vertical Split-Screen Chat | | | | | | Sysop Configurable Page Sounds (Beeping, Telephone Ringing) | | | | | | Sysop may choose Flashing "Silent Page" Mode | | | | | | Uses PCBTEXT for Language Compatibility | | | | | | Seamless Appearance when used as a "Shelled-to" Door or | | when installed as a PCBoard version 15.0 "PPE" function. | | | | Highly Sysop-Configurable | | | | | | ChatBox Version 2.3 | | | | (C) Copyright 1991-1993 Yandell Computer Services | | | | 9438 U.S. Hwy. 19 N. Suite 212 | | Port Richey, FL 34668 | | | | DATA -- (813) 842-8099 | | | | | | May 4, 1993 | | | | | | | ------------------------------------------------------------------ -------------------------------------------------------------------- ChatBox -------------------------------------------------------------------- TABLE OF CONTENTS Page ----------------- ---- INTRODUCTION ------------ 1.0 What Is ChatBox 3 1.1 What Is New in Version 2.3 (Upgrading) 3 INSTALLING ChatBox ------------------ 2.0 Preliminaries and Considerations 4 2.1 Setting Up to Use "O" to Page Sysop - PPE MODE 5 2.2 Setting Up for Sysop Initiated Chats - PPE MODE 6 2.3 Removing Previous ChatBox Installations - PPE MODE 6 2.4 Setting Up for ChatBox to Page - DOOR MODE 7-8 2.5 Setting Up for Sysop Initiated Chats - DOOR MODE 9 2.6 Preparing PCBoard for Another Chat Device - DOOR MODE 9 2.7 Running CBSETUP and Creating CHATBOX.CNF 10-15 2.8 Setting Up for Multi-Language Use 16 2.9 Setting Up V.I.P. Callers (CHATBOX.VIP) 16 2.10 Setting Up Callers Who Cannot Page (CHATBOX.NOT) 16 RUN-TIME CONSIDERATIONS ----------------------- 3.0 Notes Regarding PCBTEXT Files 17 3.1 Notes Regarding the F4 Function Key 18 3.2 Notes regarding Window (box) Clearing 18 3.3 Notes regarding the "Leave a Comment" Prompt 19 3.4 Notes Regarding SOUND.BAT 19 3.5 Notes Regarding Text File Displays 19 MISCELLANEOUS ------------- 4.0 Sysop Function Keys 20 4.1 Technical Notes 20 4.2 Caller Log Entries 21 4.3 ChatBox CHATLOG (ALT-L) Files 21 4.4 Multi-Nodes, Networks, Multi-taskers 21 4.5 Error Messages 21 4.6 Where to Receive Assistance 21 4.7 Disclaimer and Warranty 22 4.8 License to Use ChatBox 22 4.9 Revision History 22 REGISTRATION ------------ 5.0 Registering ChatBox 23 5.1 Register With CONFIDENCE - Author Information 23 -------------------------------------------------------------------- Page 3 ChatBox Page 3 -------------------------------------------------------------------- 1.0 What is ChatBox -------------------- ChatBox is a Split-Screen chat utility designed for PCBoard. The Sysop may select the Split-Screen format for chatting. In horizontal mode, the screen is split into two halves (boxes), upper and lower. In vertical mode, the screen is split into two halves (boxes), left and right. ChatBox is installed as a 'door' or 'PPE' and is designed to be used between the Sysop and an on-line caller. The Sysop may initiate the chat. ChatBox will bypass its paging process and go directly into chat mode if initiated by the Sysop. Split-Screen chatting allows simultaneous typing between the Sysop and the caller. ChatBox allows the Sysop to select the type of sound made when a caller is paging. A different tone may be selected for the familiar "beep-beep", or one of several different telephone ringing sounds may be chosen. Sysops may choose to shell to their own noise making or screen flashing program to alert them a caller is paging. Printer bells may be used also. The Sysop may edit most of the information in the caller's USER record while chatting, without the caller's knowledge. Three different paging periods may be set for each day of the week. Split-Screen chat colors may be configured by the Sysop (registered copies of ChatBox only). ChatBox uses PCBTEXT for multi-language compatibility and additional flexibility. ChatBox is DESQview aware. ChatBox works with non-standard com ports automatically. ChatBox works with regular PCBoard software or the /M Multi-port version of PCBoard automatically. 1.1 What is new in version 2.3 (upgrading) ------------------------------------------- Please refer to the enclosed file FEATURES.NEW for a list of new features in ChatBox version 2.3. The steps required to upgrade from an earlier version depend on which version of PCBoard you are using. Please carefully read the next section called "PRELIMINARIES" on the next page to determine what you need to do to upgrade from a prior version of ChatBox. -------------------------------------------------------------------- Page 4 ChatBox Page 4 -------------------------------------------------------------------- 2.0 Preliminaries and Considerations ------------------------------------- Create a directory or subdirectory where you normally place doors. Extract the entire contents of CBOX23.ZIP into this location. EXTREMELY IMPORTANT CONSIDERATIONS - PLEASE READ ------------------------------------------------ PCBoard Versions 14.5 and 14.5a ------------------------------- If you are running PCBoard 14.5/14.5a: ChatBox MUST be installed as a DOOR. Follow the directions in sections 2.4 through 2.6 (the sections with "DOOR MODE" in the title). The typical DOOR name the caller uses to page you is called PAGE, and if you wish to initiate a chat you would enter the SHIFT and F10 keys at the same time, then press another key while ChatBox loads. PCBoard Version 15.0 -------------------- If you are running PCBoard 15.0, you may use ChatBox as a DOOR as described above, or you may use it with PCBoard 15.0 PPE functions. With the PPE method, callers may page you using the "O" command designed for this purpose, and you may initiate chats by pressing SHIFT and F10 at the same time (additional keystrokes are not needed as they are with the DOOR method). If installing ChatBox with PPE functions in PCBoard 15.0, follow the directions in sections 2.1 through 2.3 (the sections with "PPE MODE" in the title). -------------------------------------------------------------------- Page 5 ChatBox Page 5 -------------------------------------------------------------------- 2.1 Setting Up to Use "O" to Page Sysop - PPE MODE --------------------------------------------------- The following step-by-step instructions will replace PCBoard's built-in (O)perator page function with ChatBox. This requires PCBoard 15.0 and the SYSPAGE.PPE function file (enclosed). (1) Run PCBSetup. (2) Select "B File Locations". (3) Select "B Configuration Files". (4) Place the highlight bar on "Name/Loc of Default CMD.LST File". (5) If you have not configured this parameter yet, you will need to refer to the PCBoard documentation and configure this PATH and FILENAME now. (6) Press F2 to edit the CMD.LST file. (7) The following setup screen will appear: Command Security PPE/MNU File -or- KeyStroke Replacement ----------- -------- --------------------------------------- #) O 10 D:\CHATBOX\SYSPAGE.PPE * Command : Place the letter O here as shown above. * Security : Enter security needed to use the the O command. * PPE/MNU File: Enter the FULL LOCATION of YOUR ChatBox directory followed by the SYSPAGE.PPE file as shown above. Note: You may use another command other than "O" here, but this is not recommended. (8) Press ESC and answer Y to save the new CMD.LST file. (9) Exit PCBSetup. (10) Make sure that SYSPAGE.PPE is located in the same directory with all other ChatBox files. (11) Restore the (O)perator command in your PCBoard main menu if you had previously removed it for earlier versions of ChatBox. Also see section 2.3 on page 6. The SYSPAGE.PPE is the PCBoard 15.0 file that will load ChatBox. The SYSPAGE.PPE file will only load a configuration file called CHATBOX.CNF, so be careful that this is the file you edit with your configuration choices using CBSETUP.EXE. If you have different CMD.LST files for any conferences, you will need to configure the "O" command in them also. -------------------------------------------------------------------- Page 6 ChatBox Page 6 -------------------------------------------------------------------- 2.2 Setting Up for Sysop Initiated Chats - PPE MODE ---------------------------------------------------- The following step-by-step instructions will install ChatBox so that the Sysop may initiate a chat with the caller using ChatBox. The Sysop simply presses the SHIFT and F10 keys at the same time. When the Sysop ends the chat, the caller is returned to the point they were at when the Sysop started the chat. This requires PCBoard 15.0 and the SYSCHAT.PPE function file (enclosed). (1) Run PCBSetup. (2) Select "G Configuration Options". (3) Select "H Function Keys". (4) Move the highlight bar to "F-Key #10". (5) Edit the parameter as follows: F-Key #10 : !D:\CHATBOX\SYSCHAT.PPE ----------------------- Start the entry with an exclamation mark as shown, followed by the FULL LOCATION of YOUR ChatBox directory, followed by the SYSCHAT.PPE file as shown. It is ABSOLUTELY MANDATORY for this entry to begin with an exclamation point (!) as shown. An exclamation point in the first position is how PCBoard knows to run a PPE function when you press the SHIFT and F10 keys at the same time. You may define up to 10 SHIFT-FUNCTION keys in PCBoard to perform various tasks. It is recommended to use SHIFT-F10 to initiate the Sysop chat, as this most closely resembles PCBoard's F10 to start a Sysop chat. (6) Exit AND save PCBOARD.DAT. These steps must be performed on on all nodes. If installed properly, whenever you press a SHIFT and F10 key at the same time, ChatBox will load and immediately be in chat mode (no paging). This may be done at anytime while the caller is on-line in PCBoard (unless they are out in a door of course). 2.3 Removing Previous ChatBox Installations - PPE MODE ------------------------------------------------------ If *BOTH* SYSPAGE.PPE and SYSCHAT.PPE are being used as described in sections 2.1 and 2.2 above, there is no longer a need to have ChatBox configured as a door. Once you are comfortable with how the new "PPE" functions are running, the door functions previously needed to make ChatBox run should be removed. - Remove PAGE (or whatever you called it) from your DOOR.LST files. - Remove the PAGE command from all main menus, door menus, etc. - Restore the (O)perator command in your PCBoard main menu. - Remove SET_F10.EXE (if used) from your BOARD.BAT files. -------------------------------------------------------------------- Page 7 ChatBox Page 7 -------------------------------------------------------------------- 2.4 Setting Up ChatBox to PAGE - DOOR MODE -------------------------------------------- You must install ChatBox as a door if you are using PCBoard version 14.5 or 14.5a. You "may" install ChatBox as a DOOR with PCBoard version 15.0, however the PPE method is a much better choice. Install a door called PAGE into your DOORS.LST file using PCBSETUP. Answer the following questions as follows: USER DOOR Filename Password Sec Login SYS SYS Shell Path to DOOR Files -------- -------- --- ----- --- --- ----- ------------------ #) PAGE 10 N Y N Y (if appropriate) Note the use of PAGE as a door name, not CHATBOX, as you will most likely want to place PAGE as a command in your main menu (BRDM). A password would usually not be required for your PAGE door. A low security level is required, as you may also be using this same door when you wish to initiate a chat with the caller. ChatBox follows the security level for the "O" command in PCBoard when ChatBox is installed as a door. Callers who are below this level will not be able to use ChatBox to page the Sysop. A USERS.SYS file MUST be created. ChatBox will not run without it, as ChatBox NEVER accesses the USERS file. A DOOR.SYS file is NOT needed. If running PCBoard 14.5a, shelling is HIGHLY recommended because it greatly increases the speed at which PCBoard returns when the caller exits from ChatBox. ChatBox has been specifically designed as a "Shell" door. Setting up ChatBox as a "swapped shell" door is not recommended unless it is needed due to memory limitations. ChatBox only requires about 98K of memory so "swapping" the "shell to" door should not be required. If you have different DOORS.LST files in your conferences, you will need to configure the PAGE door in them also. It is up to the individual Sysop as to whether or not to place the PAGE command in the doors menu, or as a command on the main menu, or both. The recommended usage is to place PAGE on the main menu and not in the doors menu. Section 2.4 continues on the next page -------------------------------------------------------------------- Page 8 ChatBox Page 8 -------------------------------------------------------------------- 2.4 Setting Up ChatBox to PAGE - DOOR MODE (continued) -------------------------------------------------------- The purpose of this section is to explain the command line calling syntax for ChatBox. Please refer to the PCBoard manual for a more complete discussion on door batch file installation. If you have named the door PAGE (recommended) the following examples would be the contents of your door file named PAGE (NOTE: do NOT place any extension such as .BAT on the PAGE file). *PREFERRED METHOD* (fast load!) ------------------------------- @echo off C:\CHATBOX\CHATBOX.EXE CHATBOX.CNF C:\PCB ---------------------- ----------- ------ | | |-> This node's home directory. | | | | | ---------> The name of the configuration | file. Enter a file NAME only. | NEVER place a location here. | -------> The executable file name. Placing its location in-line as shown results in MUCH faster response time in executing the door. The two lines above are all that is required to execute ChatBox when running as a shelled-to door in PCBoard 14.5a. If you are not running PCBoard 14.5a or you are not running ChatBox as a shelled-to door, add the call to BOARD.BAT as the third command in the door file. Do NOT end your door file with BOARD.BAT if running ChatBox as a shell-to door in PCBoard 14.5a or 15.0. *OLD FASHIONED METHOD* (tried and true, but slow load) ------------------------------------------------------ @echo off d: cd\chatbox CHATBOX.EXE CHATBOX.CNF C:\PCB c: ------ cd\pcb |-> This node's home directory. The above method will work fine with ChatBox. The only drawback is the slower loading time as a result of the changing of drives and directories in DOS. As with the "preferred method", only add BOARD.BAT to the end of the door file if you are NOT shelling to ChatBox in PCBoard 14.5a, or if you are running PCBoard 14.5. -------------------------------------------------------------------- Page 9 ChatBox Page 9 -------------------------------------------------------------------- 2.5 Setting up for Sysop Initiated Chats - DOOR MODE ----------------------------------------------------- For the Sysop to initiate an on-line chat using ChatBox, all that needs to be done is for the Sysop to type PAGE <enter> at the PCBoard main prompt. While ChatBox is loading, you must quickly press any key on the local keyboard. When ChatBox loads and sees the keystroke waiting in the local system's keyboard buffer, it knows the Sysop is initiating the chat and immediately starts in chat mode instead of "paging" mode. For this to function properly with all callers, you must install the PAGE door in PCBoard so that all callers can access it with a low security in DOORS.LST. ChatBox will follow the security level for PCBoard's "O" command when a caller pages using ChatBox as a door. * Sysop Initiated Chat - AUTOMATED Method #1 : Using PCBSETUP, you may define the ten SHIFT-FUNCTION keys (SHIFT-F1 through SHIFT-F10). This is an ideal and fast way for the Sysop to bring up the PAGE command on the caller. Bring up PCBSETUP and choose one of these keys, (SHIFT-F10 will probably be easiest to remember - F10 for PCBoard chat, SHIFT-F10 for ChatBox). These are located on the Options 2 page in PCBSETUP (version 14.5 and 14.5a). To install the PAGE command, simply enter the following: F-Key #10 : PAGE ^M The ^M must be entered exactly as shown. Whenever you wish to chat with caller, press SHIFT-F10, then press any key while ChatBox is loading to bypass the page mode and start directly in chat mode (as described in the first paragraph above). It is not possible for the caller to bring up ChatBox using this method, as the caller is never capable of placing keystrokes in the local (host) keyboard while ChatBox is loading. 2.6 Preparing PCBoard for Another Chat Device - DOOR MODE ---------------------------------------------------------- It is not necessary to disable PCBoard's "O" command in order for ChatBox to function as a door. However, if you wish to use ChatBox exclusively then follow these simple steps. (1) Set record #128 in all PCBTEXT files to: "Please use the PAGE command for paging" (2) Use PCBSETUP to set the page times in PCBOARD.DAT to one minute apart, for example 12:00 - 12:01. Setting this one minute period so that it occurs during the system event is ideal. When a caller presses "O" in PCBoard, they will receive the "Please use the PAGE command" instruction contained in record #128 of the appropriate PCBTEXT file. This applies to DOOR MODE use only! The method prescribed above allows PCBoard and ChatBox to continue using the F4 setting for its intended use. -------------------------------------------------------------------- Page 10 ChatBox Page 10 -------------------------------------------------------------------- 2.7 Running CBSETUP and Creating CHATBOX.CNF --------------------------------------------- Enclosed with ChatBox 2.3 is a file called CBSETUP.EXE. This file allows you to easily and quickly configure ChatBox configuration files. Only one CHATBOX.CNF file is required for all nodes. Please refer to section 2.8 page 16 for information on creating CHATBOX.CNF files for multi-language use. To start CBSETUP.EXE, enter CBSETUP CHATBOX.CNF at your DOS prompt (CHATBOX.CNF would be the appropriate configuration file). Each parameter in CBSETUP is described on the following pages. * ChatBox registration number --------------------------- This is the registration number received when ChatBox is registered. Registration causes the ChatBox [ UNREGISTERED COPY ] message and the brief delay at program termination to disappear. This message is not replaced with your board name or anything else. The entire line completely disappears for a true, seamless, "looks like PCBoard" process if running as a shelled-to door in PCBoard 14.5a or as a PPE in PCBoard 15.0. Registration also allows ChatBox to use the Sysop defined colors for Split-Screen chat operations. * Default chat screen type -------------------------- You may select the initial type of Split-Screen chat mode to begin the on-line chat session in. The valid selections are: (1) Horizontal Split-Screen. The Sysop will be in the top half of the screen, the caller will be in the bottom half. (2) Vertical Split-Screen. The Sysop will be in the left hand side of the screen, the caller will be in the right hand side. (3) Regular non-split screen. Self explanatory. If it is determined that the caller's communications program is not ANSI capable, ChatBox will start the chat in the regular, non-split screen mode. If this occurs, the Sysop will receive a message on the local screen stating this. The Sysop should not try to force a Split-Screen chat session when this occurs, as it will probably only result in the caller's screen being filled with unreadable ANSI escape sequences. Section 2.7 continues on the next page -------------------------------------------------------------------- Page 11 ChatBox Page 11 -------------------------------------------------------------------- 2.7 Running CBSETUP and creating CHATBOX.CNF (continued) --------------------------------------------------------- * Speed to wrap instead of scroll --------------------------------- If the caller is at or below this connect rate, ChatBox will wrap to the top of each window (box) when the box is filled with text. If the caller is above this speed, ChatBox will scroll the contents of the box up one line when the box is filled. Since scrolling separate parts of the screen may yield unfavorable results to callers with connect speeds of 300 and 1200, a setting of at least 1200 is recommended. Valid entries here are 300, 1200, 2400, & 9600. ChatBox will always wrap text to the top of a window when a caller is at 300 baud. * Name to Display for Sysop --------------------------- While in Split-Screen chat, this name is used to identify the Sysop in the status line for the Sysop's half of the screen. This name is used in the introductory "Hello, this is _____" text. This is also used if the Sysop drops to DOS in ChatBox. It will be displayed in front of appropriate "___ has exited to DOS" message. * Color to use for Chat Text ---------------------------- Chat text (text the Sysop and caller type while chatting) colors may be configured. This color is used when the caller is in color mode. Pressing F2 at this parameter in CBSETUP will display a color chart and sample Split-Screen chat display using the colors you've chosen. Chat text colors are always high intensity (bright). ChatBox must be registered for this setting to be recognized. In an unregistered copy, this will default to "2" when ChatBox is run. * Color to use for Box Lines ---------------------------- Box line (lines creating the chat "box" while chatting) colors may be configured. This color is used when the caller is in color mode. Pressing F2 at this parameter in CBSETUP will display a color chart and sample Split-Screen chat display using the colors you've chosen. Box line colors are always high intensity (bright). ChatBox must be registered for this setting to be recognized. In an unregistered copy, this will default to "6" when ChatBox is run. Section 2.7 continues on the next page -------------------------------------------------------------------- Page 12 ChatBox Page 12 -------------------------------------------------------------------- 2.7 Running CBSETUP and creating CHATBOX.CNF (continued) --------------------------------------------------------- * Color for Sysop and Caller Name --------------------------------- The Sysop and caller names are placed in the "box" lines separating each "box". This color is used when the caller is in color mode. Pressing F2 at this parameter in CBSETUP will display a color chart and sample Split-Screen chat display using the colors you've chosen. Name colors are always high intensity (bright). ChatBox must be registered for this setting to be recognized. In an unregistered copy, this will default to "6" when ChatBox is run. * Color to use for Position Arrow --------------------------------- A "position arrow" is located on the left of each chat "box" to show the current line. This color is used when the caller is in color. Pressing F2 at this parameter in CBSETUP will display a color chart and sample Split-Screen chat display using the colors you've chosen. Position arrows are always high intensity (bright). ChatBox must be registered for this setting to be recognized. In an unregistered copy, this will default to "6" when ChatBox is run. * Character for Position Arrow ------------------------------ A "position arrow" is located on the left of each chat "box" to show the current line. This character may be set by the Sysop. Any ASCII character between 32 and 255 may be used for the position arrow character. A [space] (ASCII 32) may not be used, nor may ASCII characters below 32 (control characters which some communications programs do not display properly). * Disable Window Screen Clearing -------------------------------- The Sysop and caller may clear their own "incoming" windows (the box the other person is typing in) for easier readability (horizontal split screen mode only). Entering a Y for yes in this parameter will disable this function during split-screen chat sessions. Please see page 18 section 3.2 for additional information. Section 2.7 continues on the next page -------------------------------------------------------------------- Page 13 ChatBox Page 13 -------------------------------------------------------------------- 2.7 Running CBSETUP and creating CHATBOX.CNF (continued) --------------------------------------------------------- Disable `Leave a Comment' Prompt -------------------------------- If the Sysop is unavailable (F4 key or Hours) or does not answer a page, the caller will be asked if they would like to leave a comment (just like PCBoard would). If the caller responds Yes, ChatBox will take the proper actions so that a C <ENTER> are entered at the main PCBoard prompt when PCBoard re-loads. Entering a Y for yes in this parameter will disable this function and return the caller to PCBoard whenever a page is unsuccessful. Length of Paging Time (seconds) ------------------------------- The length of time that ChatBox will beep, ring, flash, etc., during a caller page may be configured by the Sysop. Valid entries are from 15 to 90 seconds. The default is 30 seconds, which is also the same for PCBoard's built-in page. ChatBox reads record # 97 from PCBTEXT (or appropriate language file) and displays it while paging: Page ends in 30 seconds. (Ctrl-K) Aborts . ChatBox will automatically change '30' to the amount entered in this parameter. This allows PCBoard's (O) command to continue to be used in conjunction with ChatBox for those that wish to do so. Disable Use of PCBoard F4 Toggle -------------------------------- ChatBox follows the F4 'paging allowed' toggle in PCBoard. If F4 is OFF, paging will not be permitted, if F4 is ON, paging is permitted if (A) the person has security to page, and (B) if the page attempt is within a time period allowed. This means that ChatBox uses the F4 toggle EXACTLY as PCBoard's (O) command does. By using the F4 toggle, the Sysop can easily turn the page function (ChatBox or PCBoard) off on a temporary basis without having to re-configure any setup parameters. Although not recommended, you may have ChatBox ignore PCBoard's F4 by answering this parameter Yes. Section 2.7 continues on the next page -------------------------------------------------------------------- Page 14 ChatBox Page 14 -------------------------------------------------------------------- 2.7 Running CBSETUP and creating CHATBOX.CNF (continued) --------------------------------------------------------- Always Start with Log (ALT-L) On -------------------------------- ChatBox contains a toggle that allows the Sysop to log chat sessions to log files in the default ChatBox directory. This toggle is the ALT-L key combination. The (L) which appears on the ChatBox status line indicates logging is active. If the Sysop desires, ChatBox may start with the logging mode on as each chat session begins instead of manually turning it on with the ALT-L keypress. Refer to page 21 section 4.3 for information regarding chat logs. * Sound to use for VIP paging ----------------------------- You may select the type of sound ChatBox will make when a caller listed in CHATBOX.VIP pages outside of normal paging hours. (1) The familiar "beep beep". (2) The familiar "beep beep, with a lower tone than #1. (3) European telephone ring. Two short rings. (4) Telephone ring. Low pitch. (5) Telephone ring. Medium pitch. (6) Telephone ring. High pitch. (7) Silent - Flashing box on the Sysop's screen. (8) Shell - Use another program or device for sounds or screens. (9) Use LPT1 (parallel printer) bell. (10) Use LPT2 (parallel printer) bell. (11) Use LPT3 (parallel printer) bell. (12) Generic "beep beep" using console for use with older PCs. Press F2 at this parameter to listen to the sound you have selected. If selecting #8 (shell) see page 19 section 3.4 for instructions on creating SOUND.BAT. * Reason Prompt (or NONE) -------------------------- If ChatBox is being used to page the Sysop, this optional parameter may be used to ask the caller to briefly state the reason they are paging the Sysop. If this parameter is blank, or NONE is entered, this question will be disabled in ChatBox. If the Sysop is initiating the chat, this parameter is ignored. A file name may be specified in this parameter by starting the left most position with a % followed by a file. If you specify a file, do NOT specify a location. The file must reside with CHATBOX.EXE. For example: %WHY.TXT Briefly state the reason for this chat? Section 2.7 continues on the next page -------------------------------------------------------------------- Page 15 ChatBox Page 15 -------------------------------------------------------------------- 2.7 Running CBSETUP and creating CHATBOX.CNF (continued) --------------------------------------------------------- * Unavailable Text ------------------ This text is displayed when F4 is toggled off, when the caller does not have a sufficient access level to request a chat, or when a page attempt goes unanswered. For example: The Sysop is not currently available for chat. The above is displayed to the caller and written to the CALLER log. A file name may be specified in this parameter by starting the left most position with a % followed by a file. Do NOT specify a location with the name. The file must reside with CHATBOX.EXE. For example: %NO.TXT No one is available for a chat. NO.TXT is displayed to the caller, the text is written to CALLER(x). * Hours Text ------------ This text is displayed when a caller is requesting a chat outside of the hours allowed for the particular day of the week. For example: Paging is allowed hh:mm - hh:mm. Please leave a comment. The above is displayed to the caller and written to the CALLER log. A file name may be specified in this parameter by starting the left most position with a % followed by a file. Do NOT specify a location with the name. The file must reside with CHATBOX.EXE. For example: %HOURS.TXT Page is not available at this hour. HOURS.TXT is displayed to caller, the text is written to CALLER(x). * Page Start and Stop Times (CBSETUP.EXE page 2) ------------------------------------------------- You may enter 3 page starting and stopping times for each day of the week. Times must be entered in HH:MM format, where HH is a value of 0 through 23, and MM is a value of 0 through 59. CBSETUP performs minimal testing of the hours input here. Care should be taken to insure the times which are input are valid and in the HH:MM format. To disable paging on a particular day, simply set the page times for PERIOD 1 on that day a minute apart, such as 12:00 - 12:01, and set the start and stop times for PERIOD 2 & 3 to the same time. If there is concern about a caller being able to activate a page during this one minute time period during the day (which is highly unlikely), set this one minute period so it will occur during your daily event. For 24 hour paging, set PERIOD 1 to the same start and stop times. PERIODS 2 & 3 are ignored if the start and stop times are the same. The TAB key rotates through different PERIODS in the same day. -------------------------------------------------------------------- Page 16 ChatBox Page 16 -------------------------------------------------------------------- 2.8 Setting up for Multi-Language Use -------------------------------------- ChatBox uses text from PCBTEXT or appropriate language files with the exception of the text that is used in CHATBOX.CNF. To make any text in CHATBOX.CNF language compatible, simply create a duplicate CHATBOX.CNF file except give it the appropriate EXTension. For instance with French, use the appropriate French in CHATBOX.FRE and ChatBox will automatically use CHATBOX.FRE instead of CHATBOX.CNF as the configuration file. You do not need to worry about what ChatBox is passed in the door file. If passed CHATBOX.CNF and the language is .FRE, ChatBox will look for CHATBOX.FRE before using CHATBOX.CNF. 2.9 Setting up V.I.P. Callers (CHATBOX.VIP) -------------------------------------------- To create a VIP list of callers who may page at any time, create a text file called CHATBOX.VIP. It must reside in the same location as CHATBOX.EXE. To install special names into CHATBOX.VIP, simply enter the names one at a time, with each name beginning on a new line. Callers who appear in CHATBOX.VIP will be able to page the Sysop at any time regardless of page time settings. Callers who are listed in CHATBOX.VIP will NOT be able to PAGE the Sysop if the F4 page bell toggle has been turned off in PCBoard (unless the ability to follow the F4 setting has been disabled with CBSETUP). It is assumed that if the Sysop has turned F4 off then they really don't wish to disturbed. 2.10 Setting up Callers Who Cannot Page (CHATBOX.NOT) ------------------------------------------------------ To create a list of callers who can NEVER page, regardless of page time settings, F4 page toggle, etc., create a text file called CHATBOX.NOT. It must reside in the same location as CHATBOX.EXE. To install names into CHATBOX.NOT simply enter the names one at a time, with each name beginning on a new line, and with each line ending with a carriage-return line-feed sequence. -------------------------------------------------------------------- Page 17 ChatBox Page 17 -------------------------------------------------------------------- 3.0 Notes regarding PCBTEXT files ---------------------------------- ChatBox detects the language being used and uses the following text from the appropriate PCBTEXT (PCBTEXT.???) file. Rec# Default text 97 Page ends in 30 seconds. (Ctrl-K) Aborts . Notes: ChatBox will automatically replace '30' with the number of seconds for paging time set in CBSETUP.EXE. 175 Sysop CHAT active at~ Notes: Written to caller log only. Time is added to end. 219 Sysop CHAT ended at~ Notes: Written to caller log and displayed after a chat. Time is added to end of line. 327 I'm back! Thanks for waiting~ Notes: Displayed on return from Sysop F5. Caller's first name is added to end of the line. 333 Hello, This is @OPTEXT@.~~ Notes: Displayed in Sysop's "box" when a chat begins. Chatbox will replace @OPTEXT@ with Sysop's name in CBSETUP. 409 Operator paged at~ Notes: Written to caller log only. Time is added to the end of the line, followed by the REASON the caller paged (if used). 418 Press (Enter) to continue Notes: Self explanatory. 436 ______ has exited to DOS. Please wait ... Notes: Displayed when Sysop F5'd to DOS. Sysop's name in CBSETUP is added to the beginning of the line. 571 Would you like to leave a comment to the Sysop instead Notes: Used if a page attempt is unsuccessful. ADDITIONAL NOTES: ----------------- @FIRST@ (caller's first name) may be used in any line. ChatBox replaces ~ characters with hard spaces in the same fashion PCBoard does in PCBTEXT. The text used from PCBTEXT files is simple informational text. ChatBox does not support the use of %FILENAME conventions in any of the above PCBTEXT parameters. -------------------------------------------------------------------- Page 18 ChatBox Page 18 -------------------------------------------------------------------- 3.1 Notes Regarding The F4 Function Key ---------------------------------------- ChatBox follows the F4 toggle from PCBoard. This allows the Sysop to easily toggle paging on or off at any time. ChatBox will not follow the F4 toggle if ability to so has been disabled with CBSETUP. If so, all references to any F4 key action in this manual should be disregarded. The Sysop may also set the F4 toggle while in ChatBox. To determine if you have F4 toggled ON in PCBoard, look at PCBoard's call waiting screen. The very center information block will indicate whether "Page Bell is Off" or "Page Bell is On". If you are in PCBoard locally or a caller is on-line, you can determine if F4 is toggled on by the (B) on the very bottom status line. There may be a "P" or "A" in the parenthesis with the "B", (PAB), (AB), etc. depending on how other toggles are set in PCBoard. If a "B" is there, the page bell is toggled on and a caller may page the Sysop if the current time is within a specified paging period. 3.2 Notes regarding window (box) clearing ------------------------------------------ If this feature is allowed (in CBSETUP), the Sysop and caller may clear their incoming windows for easier readability while chatting. The Sysop sees this line in the center of the screen: [ Name ]---------------------[ ALT-C=Clear ^ ]---------------------- The caller sees this line in the center: [ Name ]----------------------[ ESC=Clear v ]----------------------- Note: The (^ and v) in each line above are actually up and down arrows, and not reproduced in the documentation to prevent problems while printing the documentation. The caller must press ESC and the Sysop must press ALT-C to clear the incoming window. This places the last line of text in the window at the top of the window. NOTE: Each person may only clear the incoming text from the other person. It is not practical to allow the person typing to clear the window they are typing (sending) in, as it is IMPOSSIBLE to know if the other person has read, or is keeping up with, the other person's typing! This is only available in Horizontal mode. The performance of this feature while in Vertical chat mode was not favorable enough to include it in ChatBox. -------------------------------------------------------------------- Page 19 ChatBox Page 19 -------------------------------------------------------------------- 3.3 Notes regarding the "Leave a comment instead?" prompt ---------------------------------------------------------- If the Sysop is unavailable (F4 key or Hours) or does not answer a page, the caller will be asked if they would like to leave a comment. ChatBox uses record #571 from PCBTEXT for this purpose. If the caller responds Yes, ChatBox will take the proper actions so that a C <ENTER> are entered at the PCBoard prompt after ChatBox exits and PCBoard will act as though it were typed by the Caller. NOTE: Use of this feature requires that your main menu (BRDM) not be so long that it normally requires a "More" prompt to appear. If BRDM is too long, PCBoard will ask the "More" question, the C will be entered and ignored, then the <ENTER> will be used by the "More" question. This feature can be disabled with CBSETUP if it is not desired. 3.4 Notes regarding SOUND.BAT ------------------------------ SOUND.BAT is called if #8 has been selected for the type of sound to make when paging. ChatBox will shell out to SOUND.BAT every couple of seconds instead of making a selected noise. This allows the Sysop to make their own noise, screen displays, etc. Note: We have received reports that sound cards have been successfully used to create page sounds in SOUND.BAT. It should be noted that this process could have difficulties. It would not be surprising for some sound card drivers to created problems with communications programs. Test carefully and thoroughly if you plan on using a sound card to create page sounds. In all cases, keep whatever is placed in SOUND.BAT small and fast. 3.5 Notes regarding text file displays --------------------------------------- ChatBox will display text files if indicated in certain text prompts in CBSETUP. These text files support PCBoard color macros. Because ChatBox has been designed to be as small as possible for "shell to" door purposes, ANSI capabilities in these text files have been intentionally omitted. These text files also support the use of the @cls@ clear screen macro, as well as the use of @first@ for the caller's first name. Support for a multitude of @info@ macros has been intentionally omitted to keep memory consumption as low as possible for use in the "shell to" door process. If multi-languages are in use, the appropriate extension will be added to these files. If the language file exists, it will be shown to the caller. -------------------------------------------------------------------- Page 20 ChatBox Page 20 -------------------------------------------------------------------- 4.0 Sysop function keys ------------------------ ChatBox follows F3 (printer on/off), F4 (page bell on/off) and F9 (display on/off) toggles from PCBoard. If F3 is on, ChatBox will print any information sent to the caller log to the printer also. If F9 is off, ChatBox will clear the screen after an unsuccessful page attempt. The F4 key is explained in detail elsewhere in this manual. Sysops may drop to DOS using the F5 key if F5 drop to DOS is enabled in PCBSETUP for the node. During a chat, the Sysop may press ALT-P for a profile screen containing many of the caller's statistics and settings. In Split- Screen chat, this appears over the "box" the Sysop would normally type in, and the caller is unaware of its presence. In fact, the caller may keep typing while the Sysop is reviewing the profile! After the Sysop has reviewed the profile the contents of the Sysop's "chatbox" will be restored. In regular non-split screen chat mode, the caller will not be able to continue typing while the profile information is popped up on the Sysop's screen. While the above ALT-P information is on the screen, the Sysop may edit any of the caller's parameters displayed by pressing ALT-E for edit. The Sysop may then cursor through the parameters making changes as needed. Caller input is not accepted while the Sysop is actually Editing the Profile. The Sysop may press ALT-S to save and record any changes or ALT-A to abort any changes. After pressing ALT-S or ALT-A while editing, chatting will resume as normal. ChatBox will act on ALT-X and ALT-N requests from the Sysop. ChatBox will set the appropriate flag so that PCBoard will use it after the caller logs off (as if ALT-X or ALT-N had been set in PCBoard). 4.1 Technical notes -------------------- ChatBox has been designed to run specifically with PCBoard versions 14.5, 14.5a and 15.0. ChatBox will not run with earlier versions of PCBoard or with other brands of software. Carrier is monitored by ChatBox. Should a caller drop carrier while in ChatBox they will be returned to PCBoard, which will detect the "no carrier" status and cycle appropriately. ChatBox works with non-standard com ports, addresses, and IRQs. COM1 is address 3F8/IRQ 4. COM2 is address 2F8/IRQ 3. If a COM port other than 1 or 2 is used, ChatBox will use the address and IRQ information as indicated in PCBOARD.DAT for the node. ChatBox gives the caller time credit while chatting with the Sysop. If it is detected that the caller's communications program is not ANSI capable, ChatBox will start the chat in the regular, non-split screen chat mode. A message will appear on the Sysop's screen if this occurs. -------------------------------------------------------------------- Page 21 ChatBox Page 21 -------------------------------------------------------------------- 4.2 Caller log entries ----------------------- ChatBox makes pertinent entries into the caller log as follows: If a REASON for paging is requested, the caller's answer is appended to the "Operator Paged at" text and written to the CALLER files. The "Hours available" text from CBSETUP is written to CALLER files if a page is attempted outside of paging times. The "Unavailable text" from CBSETUP is written to CALLER files if the caller lacks security to page, if F4 page is OFF, or if the Sysop does not answer a page attempt. Also see section 3.0 page 17 for other text which is written to CALLER files by ChatBox. 4.3 ChatBox CHATLOG (ALT-L) files ---------------------------------- Sysops may keep a record of the contents of their chat with a caller by entering ALT-L during the chat. ChatBox will add the text of the chat to a file called CHATLOG.xxx, where xxx is the node number the chat is occurring on. CHATLOG files are located with CHATBOX.EXE. CHATLOG files are appended (added) to with each ALT-L, so care should be taken if this feature is used often so that the log files will not become too large to handle. You may turn logging turned ON by default during each chat session by toggling the appropriate setting in CBSETUP.EXE. 4.4 Multi-nodes, networks, multi-taskers ----------------------------------------- ChatBox has been developed in a networked environment. All multi- node features are thoroughly tested on our own multi-node PCBoard system. ChatBox is DESQview aware. It is automatically detected, screen and keyboard I/O are "well behaved", and time slices are given back to other applications while ChatBox is idle. 4.5 Error messages ------------------- ChatBox gives verbose installation error messages, such as invalid paths. These messages appear and there is a short pause while they are displayed. 4.6 Where to receive assistance -------------------------------- Yandell Computer Services (YCS) provides the following technical assistance for ChatBox: 813-842-8099 The YCS Support System. Available to all BBS Sysops. INSTANT on-line credit card registration and support system for YCS Shareware. -------------------------------------------------------------------- Page 22 ChatBox Page 22 -------------------------------------------------------------------- 4.7 Disclaimer and Warranty ---------------------------- ChatBox is a shareware product. ChatBox may be uploaded to BBS systems as long as copyright notices are not removed and no changes are made to the program. There are no warranties, expressed or implied, for unregistered copies of ChatBox. Sysops who install ChatBox on their systems assume any and all liabilities for anything which may result as a consequence of running ChatBox. For registered copies of ChatBox, Yandell Computer Services warrants that ChatBox will perform as described in this documentation. In the event that ChatBox does not perform as specified, Yandell Computer Services may elect to fix ChatBox or refund the amount paid, if notified within 30 days of registration. Under no circumstances shall Yandell Computer Services or the author of ChatBox be liable for any loss of profit or any other damages, including but not limited to special, incidental, consequential, or other damages, arising out of the use or inability to use ChatBox. 4.8 License to Use ChatBox --------------------------- ChatBox is not "public domain" or "free" software. A limited license is granted to use and evaluate ChatBox for thirty days after initial installation. ChatBox must be registered if it is used after the initial thirty day evaluation period. A ChatBox registration may be used only on the original licensee's BBS system and only on nodes the original licensee owns and operates for their own purposes. If the original licensee leases or sells some or all of their nodes to another entity, those nodes will require their own ChatBox registration. ChatBox registrations are not transferable. A ChatBox registration is a license to use the ChatBox software on one (1) BBS System at a single location with as many nodes as the original licensee owns and operates at THAT location. When the licensee owns and operates other BBS' in other locations, each location will require a separate ChatBox registration. If ChatBox has not been registered after 30 days, a Sysop reminder will begin appearing at program termination and will also be written to the current node's caller log file. 4.9 Revision history --------------------- Date Version Details -------- ------- ------- 06-14-91 1.0 ChatBox initial release. 08-10-91 1.1 See the enclosed FEATURES.NEW file. 11-08-91 1.2 See the enclosed FEATURES.NEW file. 12-20-91 1.3 See the enclosed FEATURES.NEW file. 03-27-92 2.0 See the enclosed FEATURES.NEW file. 05-01-92 2.1 See the enclosed FEATURES.NEW file. 11-27-92 2.2 See the enclosed FEATURES.NEW file. 05-04-93 2.3 See the enclosed FEATURES.NEW file. -------------------------------------------------------------------- Page 23 ChatBox Page 23 -------------------------------------------------------------------- 5.0 Registering ChatBox ------------------------ Registration removes the [UNREGISTERED COPY] message at program termination along with the corresponding brief delay. Registration also enables the Sysop definable colors for Split-Screen chat. Registration is $15.00 and may be paid by check, money order, VISA, Mastercard, American Express or Diners Club. Receive a registration number INSTANTLY by registering with a credit card! Refer to the ORDER.FRM file for complete registration instructions. 5.1 Register with CONFIDENCE - Author Information -------------------------------------------------- L. Brent Yandell has been programming for over eleven years, including more than five years of developing telecommunications software. Many Sysops will be familiar with PCBFV, the popular on- line PCBoard File Viewer. See the enclosed CATALOG.TXT file for a complete listing of Sysop utilities from YCS. Yandell Computer Services (YCS) is a licensed business, operating and existing under the laws of the State of Florida. Writing BBS Shareware doors and utilities, in addition to custom programming, is our business.... our ONLY business. First Door Release: 7/6/87 (USBBSDOR) - Still updated and supported! YCS Shareware is GUARANTEED (each product's documentation contains each product's specific guarantee). Yandell Computer Services is an *AUTHORIZED* merchant for VISA, Mastercard, American Express and Diners charge cards. A dedicated multi-node BBS for support and on-line registrations, a toll-free voice line for registrations, and a voice support line for registered customers are just a few of our offerings in our efforts to provide you with FAST, FRIENDLY SERVICE.